<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>tableproc.agg</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="tableproc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="https://code.google.com/p/py-table-processing/">py-table-processing</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="tableproc-module.html">Package&nbsp;tableproc</a> ::
        Module&nbsp;agg
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="tableproc.agg-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module agg</h1><p class="nomargin-top"><span class="codelink"><a href="tableproc.agg-pysrc.html">source&nbsp;code</a></span></p>
<p>Library of aggregators useful when grouping table elements.</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        Christophe Alexandre &lt;optimacom.sarl at gmail dot com&gt;
      </p>
      <p><strong>License:</strong>
        Copyright(C) 2010 Optimacom sarl
        <p>This program is free software: you can redistribute it and/or 
        modify it under the terms of the GNU Lesser General Public License 
        as published by the Free Software Foundation, either version 3 of 
        the License, or (at your option) any later version.</p>
        <p>This program is distributed in the hope that it will be useful, 
        but WITHOUT ANY WARRANTY; without even the implied warranty of 
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
        General Public License for more details.</p>
        <p>You should have received a copy of the GNU Lesser General Public
        License along with this program.  If not, see 
        &lt;http://www.gnu.org/licenses/lgpl.txt&gt;.</p>
      </p>
</div><!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_sum" class="summary-sig-name">agg_sum</a>()</span><br />
      Aggregate: None-tolerant version of sum().</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_sum">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_count" class="summary-sig-name">agg_count</a>()</span><br />
      Aggregate: None-tolerant version of len().</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_count">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_avg" class="summary-sig-name">agg_avg</a>()</span><br />
      Aggregate: computing average value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_avg">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_const" class="summary-sig-name">agg_const</a>(<span class="summary-sig-arg">c</span>)</span><br />
      Aggregate: constant c.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_const">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_min" class="summary-sig-name">agg_min</a>()</span><br />
      Aggregate: finds minimum.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_min">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="tableproc.agg-module.html#agg_max" class="summary-sig-name">agg_max</a>()</span><br />
      Aggregate: finds maximum.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="tableproc.agg-pysrc.html#agg_max">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="agg_sum"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_sum</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_sum">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: None-tolerant version of sum().</p>
  <p>Use case: d = { '0': agg_sum() }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="agg_count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_count</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_count">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: None-tolerant version of len().</p>
  <p>Use case: d = { '0': agg_count() }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="agg_avg"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_avg</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_avg">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: computing average value.</p>
  <p>Use case: d = { '0': agg_avg() }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="agg_const"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_const</span>(<span class="sig-arg">c</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_const">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: constant c.</p>
  <p>Use case: d = { '0': agg_const(3) }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="agg_min"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_min</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_min">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: finds minimum.</p>
  <p>Use case: d = { '0': agg_min() }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="agg_max"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">agg_max</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="tableproc.agg-pysrc.html#agg_max">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Aggregate: finds maximum.</p>
  <p>Use case: d = { '0': agg_max() }</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="tableproc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="https://code.google.com/p/py-table-processing/">py-table-processing</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Nov 25 17:48:12 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
